GetSecurityGroupElement(IUAReadOnlyPubSubSecurityKeyService,String,IReadOnlyList<String>) Method

Get the element for the specified security group.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function GetSecurityGroupElement( _
   ByVal readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService, _
   ByVal securityGroupId As String, _
   ByVal securityGroupFolderPath As IReadOnlyList(Of String) _
) As SecurityGroupElement

'Usage
 
Dim readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService
Dim securityGroupId As String
Dim securityGroupFolderPath As IReadOnlyList(Of String)
Dim value As SecurityGroupElement
 
value = IUAReadOnlyPubSubSecurityKeyServiceExtension.GetSecurityGroupElement(readOnlyPubSubSecurityKeyService, securityGroupId, securityGroupFolderPath)

[Extension()]
[NotNull()]
public static SecurityGroupElement GetSecurityGroupElement( 
   IUAReadOnlyPubSubSecurityKeyService readOnlyPubSubSecurityKeyService,
   string securityGroupId,
   IReadOnlyList<string> securityGroupFolderPath
)

[Extension()]
[NotNull()]
public:
static SecurityGroupElement^ GetSecurityGroupElement( 
   IUAReadOnlyPubSubSecurityKeyService^ readOnlyPubSubSecurityKeyService,
   String^ securityGroupId,
   IReadOnlyList<String^>^ securityGroupFolderPath
)

Parameters

readOnlyPubSubSecurityKeyService: OPC UA PubSub security key service (read-only).
securityGroupId: The Id of the security group.
securityGroupFolderPath: An optional path to the folder that contains the security group.

Return Value

Returns the security group element.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
OpcLabs.EasyOpc.UA.OperationModel.UALogicalException	There is a logical error in the OPC UA operation. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

OpcLabs.EasyOpc.UA.OperationModel.UALogicalException

There is a logical error in the OPC UA operation.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IUAReadOnlyPubSubSecurityKeyServiceExtension Class
IUAReadOnlyPubSubSecurityKeyServiceExtension Members
Overload List

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.